home *** CD-ROM | disk | FTP | other *** search
/ The Games Machine 131 / XENIATGM131.iso / Goodies / I-WAR 2 Egde of Chaos - New SDK / IW2-EOC_Pog_Scripting_SDK.exe / include / iConversation.h < prev    next >
Text File  |  2002-01-14  |  2KB  |  82 lines
  1. //
  2. // (c) 1999-2000 Particle Systems Ltd. All Rights Reserved
  3. //
  4. // iConversation.h
  5. //
  6. // Simple conversation API. This package wraps calls to the iComms package
  7. // and handles conversation timing issues.
  8. //
  9. // Revision control information:
  10. //
  11. // $Header: /iwar2/resource/scripts/include/iConversation.h 2     4/04/00 17:12 Will $
  12. //
  13.  
  14. // Dependencies ///////////////////////////////////////////////////////////////
  15.  
  16. // Type definitions ///////////////////////////////////////////////////////////
  17.  
  18. // Function prototypes ////////////////////////////////////////////////////////
  19.  
  20. //
  21. // iConversation.Begin
  22. //
  23. // Begin a conversation with the given speaker. This function will not return
  24. // until the conversation can be started (i.e. until the comms system is not
  25. // busy.)
  26. //
  27. prototype iConversation.Begin();
  28.  
  29. //
  30. // iConversation.End
  31. //
  32. // End the current conversation.
  33. //
  34. prototype iConversation.End();
  35.  
  36. //
  37. // iConversation.Say
  38. //
  39. // Say a phrase in a conversation. This function will not start the phrase 
  40. // until the comms system is free, and will not return until the phrase has
  41. // finished.
  42. //
  43. prototype iConversation.Say( hobject speaker, 
  44.                              string speaker_key, 
  45.                              string phrase_key );
  46.  
  47. //
  48. // iConversation.AddResponse
  49. //
  50. // Add a response to the current conversation response list. Response are 
  51. // numbered starting from 1 in the order in which they are added, and are
  52. // displayed on the screen in this order.
  53. //
  54. // The response list is cleared at the start of a conversation and also
  55. // following each question.
  56. //
  57. prototype iConversation.AddResponse( string menu_key, string phrase_key );
  58.  
  59. //
  60. // iConversation.Ask
  61. //
  62. // Ask a question in a conversation. This function will not return until
  63. // the player has selected a response. The return value is the number of
  64. // the player's response in the response list. (See above for details.)
  65. //
  66. prototype int iConversation.Ask( hobject speaker, 
  67.                                  string speaker_key, 
  68.                                  string phrase_key );
  69.  
  70. //
  71. // iConversation.OneLiner
  72. //
  73. // Hold a one-line conversation. This is different from a shout in that the
  74. // function will wait for the comms system to become free.
  75. //
  76. prototype iConversation.OneLiner( hobject speaker,
  77.                                   string speaker_key,
  78.                                   string phrase_key );
  79.  
  80. // EOF ////////////////////////////////////////////////////////////////////////
  81.  
  82.